home *** CD-ROM | disk | FTP | other *** search
/ Aminet 52 / Aminet 52 (2002)(GTI - Schatztruhe)[!][Dec 2002].iso / Aminet / disk / misc / SFSCheck.readme < prev   
Text File  |  2002-10-13  |  11KB  |  282 lines
  1. Short:    Utility to check a SmartFileSystem device structure
  2. Author:   Marcin "Morgoth" Kurek <morgoth6@box43.pl>
  3. Uploader: Marcin "Morgoth" Kurek <morgoth6@box43.pl>
  4. Version:  2.4
  5. Type:     disk/misc
  6. Requires: Kickstart 3.0
  7. Replaces: SFSCheck.lha
  8.  
  9. --------------- Introduction ---------------
  10.  
  11. Completly re-written SFSCheck 1.x which can be found 
  12. in most SFS distributions. All functions from the old program 
  13. are available in this new utility. Additionally there are many new
  14. features and bug fixes.
  15.  
  16. Although it is not the final version, its functionality 
  17. overtakes the original SFSCheck.
  18. There are stil some upgrades to come in the final version.   
  19.  
  20. --------------- Legal ---------------
  21.  
  22. The author DOES NOT take any responsibility for any damage 
  23. occured while using this tool.
  24.  
  25.  !THERE ARE NO WARRANTIES!
  26.  
  27. SFSCheck may be freely distributed. It is freeware!
  28.  
  29. --------------- New Features ---------------
  30.  
  31. - checks and displays device fragmentation
  32. - able to create a list of fragmented files
  33. - able to create a list of objects with special SFS attributes
  34. - recognizes  volumes given as a argument
  35. - support for locale.library (fully localized)
  36. - displays crucial information about device
  37. - reduced memory fragmentation
  38. - support for CTRL+C command
  39. - buildin defragmenter
  40. - can' purge .recycled directory before defragment device
  41. - smart .recycled detection (you can safely rename .recycled directory)
  42. - ready for MorphOS and/or OS 4.0 (pure C/C++ code)
  43.  
  44. --------------- Usage ---------------
  45.  
  46. Template: DEVICE/A,
  47. LOCK/S,FRAGLIST/S,SEEK/S,FORCE/S,QUICK/S,DEFRAGMENT/S,
  48. P=PURGE/S,FP=FULLPATH/S,
  49. NCHK=NOCHECK/S,NORB=NOROOTBLOCKS/S,NOASC=NOADMINSPACECONTAINERS/S,NONC=NONODECONTAINERS/S,NOOC=NOOBJECTCONTAINERS/S,NOBMP=NOBITMAP/S,NOFRG=NOFRAGMENTATION/S,
  50. FRL=FRAGMENTATIONLIMIT/N/K,ADDB=ADDBUFFERS/N/K,L=LINES/N/K,RAHS=READAHEADSIZE/N/K
  51.  
  52. Required arguments:
  53.  
  54.   DEVICE/A: device/volume to check
  55.  
  56. Optional arguments:
  57.   
  58.   LOCK/S:  If you specify this parameter, SFScheck locks 
  59.            the device/volume for the duration of the scan 
  60.            by using ACTION_INHIBIT.
  61.  
  62.   FRAGLIST/S:  If you specify this parameter, SFScheck displays a 
  63.                detailed list of fragmented files of the specified
  64.                device/volume with this syntax:
  65.  
  66.                ...
  67.                Fragmented file: FileName [Object Node Number], number of fragments
  68.                ...
  69.  
  70.   SEEK/S:  If you specify this parameter, SFScheck displays a
  71.            detailed list of objects with special SFS attributes 
  72.            of the specified device/volume with this syntax
  73.  
  74.            ...
  75.            Object Type: Object Name [Object Node Number] Attributes: [List of Attributes]
  76.            ...
  77.  
  78.   FORCE/S: If you specify this parameter, SFScheck will force check for too old
  79.            version of SmartFileSystem or no SmartFileSystem devices.
  80.            This do not affected DEFRAGMENT this one require 1.83+ 
  81.            and FORCE will not help.
  82.  
  83.   QUICK/S: If you specify this parameter, SFSCheck will perform only
  84.            ObjectContainers and fragmentation check.
  85.            You can also specyfy a SEEK/S, FRAGLIST/S FORCE/S or FP=FULLPATH/S options.
  86.  
  87.   DEFRAGMENT/S: If you specify this parameter, SFSCheck will defragment the device
  88.                 after check it. For now it's only a simple reworked old SFSDefrag
  89.                 but I will change this ... soon.
  90.                 Also this option require SmartFileSystem 1.83+ and refuset to work
  91.                 with anything bellow.
  92.  
  93.   P=PURGE/S: If you specify this parameter, SFSCheck will unprotect if nesesary and 
  94.              delete all files in .recycled directrory before defragment device.
  95.              SFSCheck will detect is .recycled directory exists then specyfy 
  96.              this option when device is formated without it is safe.
  97.              You can also rename this directory and PURGE/S will still work without
  98.              any problem.
  99.              Requires DEFRAGMENT to work
  100.  
  101.   FP=FULLPATH/S:  If you specify this parameter, SFScheck forces 
  102.                   SEEK, FRAGLIST and PURGE to display the full path of an object; 
  103.                                     requires either of these to work
  104.  
  105.   NCHK=NOCHECK/S: If you specify this parameter, SFScheck will skip all it's
  106.                   checks (RootBlocks, AdminSpaceContainers, NodeContainers, 
  107.                   ObjectContainers, Bitmap, Fragmentation)
  108.                   Useful when you want only defragment the device
  109.  
  110.   NORB=NOROOTBLOCKS/S: If you specify this parameter, SFScheck will skip
  111.                        RootBlock check
  112.  
  113.   NOASC=NOADMINSPACECONTAINERS/S: If you specify this parameter, SFScheck will skip
  114.                                   AdminSpaceContaines check
  115.   
  116.   NONC=NONODECONTAINERS/S: If you specify this parameter, SFScheck will skip
  117.                            NodeContainers check
  118.  
  119.   NOOC=NOOBJECTCONTAINERS/S: If you specify this parameter, SFScheck will skip
  120.                              ObjectContainers check and fragmentation check
  121.   
  122.   NOBMP=NOBITMAP/S: If you specify this parameter, SFScheck will skip
  123.                     Bitmap check
  124.   
  125.   NOFRG=NOFRAGMENTATION/S: If you specify this parameter, SFScheck will skip
  126.                            Fragmentation check
  127.  
  128.   FRL=FRAGMENTATIONLIMIT/N/K: If you specify this parameter, SFScheck will skip
  129.                               device defragmentation if fragmentation is lower
  130.                               than limit.
  131.  
  132.                               example: if fragmentation is 27% and 
  133.                                        fragmentation limit is set to 50 SFSCheck
  134.                                        will skip defragmentation because 
  135.                                        fraglimit > fragmentation
  136.                                        but if fragmentation 
  137.                                        is for example 73% SFSCheck will defragment
  138.                                        device (fraglimit < fragmentation)
  139.  
  140.   ADDB=ADDBUFFERS/N/K: Indicate how many buffers SFSCheck will add for defragmentation.
  141.                        There is higly recomendet to set rather high values to speed up
  142.                        defragmentation process. All buffers are removed after defragmentation.
  143.  
  144.   L=LINES/N/K:  The number of lines SFScheck uses for its cache
  145.                 during the check. Default is 128 lines
  146.  
  147.  
  148.   RAHS=READAHEADSIZE/N/K:  The size of each cache line; 
  149.                            the entered value is treated as the number 
  150.                            of kilobytes to use. Default is 8 kb
  151.  
  152.     example: L=512 RAHS=32 forces SFScheck to use 512 lines, 32 kb each,
  153.              requires 16 MB of free memory (512 * (32 * 1024))
  154.  
  155.  
  156. --------------- Notes - SFSCheck ---------------
  157.  
  158. This tool checks a SFS disk's structure and looks for anything which is wrong. 
  159. It makes no modifications, it only reads the device.
  160. Any error it finds will be displayed.
  161.  
  162. You can use this tool to give more detailed information when
  163. reporting bugs to SFS author, but also to convince yourself that the SFS
  164. device is still working smoothly.
  165.  
  166. If SFScheck reports errors, the best thing to do would be 
  167. to backup important files and reformat.
  168.  
  169. Continous using of a SFS disk with errors will eventually
  170. result in fatal errors which could mean you lose all data on that
  171. device. In that case try to use a SFSSalve utility to recover your data.
  172.  
  173. Do not run SFScheck when you are writing something to the
  174. disk. SFScheck will get confused (because the structure
  175. changes right under its feet) and reports errors which
  176. are not really there.  This is not dangerous as SFScheck only
  177. reads the disk (it can not repair a disk), but you should be
  178. aware of this when using SFScheck. Use LOCK/S to avoid this.
  179.  
  180. SFScheck can be used on SFS devices only. Using it on other type 
  181. of devices is harmless. SFScheck will simply report that 
  182. the device is not in the correct format.
  183.  
  184. SFScheck returns following values:
  185.  
  186. - 0  (OK)    - everything is OK
  187. - 5  (WARN)  - CTRL+C break detected
  188. - 10 (ERROR) - wrong command line argument
  189. - 20 (FAIL)  - scan error occured (bad block, cache error, SFS fails?)
  190.  
  191. --------------- Notes - Defragmenter ---------------
  192.  
  193. Defragments files and free space.
  194.  
  195. 100% transparent; defragment a disk while you're still
  196. reading and writing data from/to it (SFS won't guarantee
  197. a 100% defragmented disk when the disk has been modified
  198. during defragmentation though).
  199.  
  200. Defragmentation uses the same safe-writing techniques which
  201. SFS always uses.  This means a crash, reset or power failure
  202. will not cause you to lose any data, even while the
  203. defragmenter is running.
  204.  
  205. The price you pay for this feature is speed and a not 100%
  206. optimal defragmentation (there is a big difference between
  207. a simple defragmenter and a disk optimizer like ReOrg).
  208.  
  209. A very simple interface is provided to activate the
  210. defragmenter built-in SFS.  See packets.h and the source of
  211. SFSdefragmentGUI for more information.
  212.  
  213. --------------- History ---------------
  214.  
  215. 2.3 (26.07.2002) - First public release.
  216. 2.4 (31.08.2002) - Fixed a small bug in Volume's support
  217.                  - No longer print "General device init. error" 
  218.                    when there is no space for it's internal caches
  219.                  - Added FORCE/S and QUICK/S switch
  220.                  - Added DEFRAGMENT/S, FL=FRAGMENTATIONLIMIT/N/K and ADDB=ADDBUFFERS/N/K
  221.                  - Added NCHK=NOCHECK/S,NORB=NOROOTBLOCKS/S,
  222.                          NOASC=NOADMINSPACECONTAINERS/S,NONC=NONODECONTAINERS/S,
  223.                          NOOC=NOOBJECTCONTAINERS/S,NOBM=NOBITMAP/S,NOF=NOFRAGMENTATION/S
  224.                  - Added polish locale
  225.                  - Added français locale
  226.                  - Added deutsch locale
  227.                  - Added SFSCheck.script and SFSDefrag.script
  228.                    WARNING: Both of them require something about 20 MB free memory
  229.                             in one block !!
  230.  
  231. --------------- ToDo ---------------
  232.  
  233. - GUI
  234. - ALL/S - seek&check all SFS devices
  235. - MorphOS version
  236. - repair SFS devices
  237. - find the rest of the bugs ;)
  238.  
  239. --------------- ThX ---------------
  240.  
  241. John Hendrikx   - For wonderful SFS of coz :)
  242. Jörg Strohmayer - For keep it alive
  243.  
  244. Adam "Vaghax" Potempa - For help with this manual
  245.  
  246. All people from #MorphOS canal for many help not only in development of this tool
  247.  
  248. All people from my Beta Team (in alphabetically order)
  249. - Duncan Gow,
  250. - Dietmar Lakotta,
  251. - Daniel Rangel,
  252. - Enrique R. Mecklenburg Serkovic,
  253. - Henri,
  254. - Jarek  "Ajuô"  Balcer,
  255. - Jerome Chesnot,
  256. - Mathias Uhlig,
  257. - OPI,
  258. - P-O Yliniemi,
  259. - Thomas Igracki,
  260. - Tony van Haarlem,
  261. - Zapek
  262.  
  263. Translators:
  264.  
  265. - Jerome Chesnot <jchesnot@noname.fr> - French Translation and manual
  266. - Thomas Igracki <igracki-thomas@berlinwebmail.de> German Translation and Manual
  267. - Jaroslaw Balcer <ajus79@box43.pl> - Polish Translation
  268.  
  269. All people that I forgot :(
  270.  
  271. --------------- Support ---------------
  272.  
  273. Feel free to send me your suggestions and/or bug reports.
  274.  
  275. --------------- Author ---------------
  276.  
  277. Marcin "Morgoth" Kurek
  278.  
  279. morgoth6@box43.pl
  280.  
  281. --------------------------------------
  282.